/*
 * MIT License
 *
 * Copyright (c) 2024-2048 冰羽
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package cn.star.framework.gen.model.field;

import cn.hutool.core.util.StrUtil;
import cn.star.framework.core.IdStrategyValue;
import cn.star.framework.gen.core.IModel;
import java.beans.Transient;
import lombok.Getter;
import lombok.Setter;

/**
 * 实体字段<br>
 *
 * @author zhaoweiping
 *     <p style='color: red'>Created on 2024-09-23 11:06:00
 * @since 3.0.0
 */
public class EntityField implements IModel {
  @Getter @Setter private String name;
  @Getter @Setter private Class<?> type;
  @Setter private String describe;
  @Getter @Setter private TableColumnInfo column;
  @Getter @Setter private int order = 0;
  /** {@link Transient} */
  @Getter @Setter private boolean persistence = true;
  /** 主键策略默认为空 */
  @Getter @Setter private Class<? extends IdStrategyValue> idStrategyClass;
  /** 是否是二进制或者大文本字段 */
  @Getter @Setter private boolean lob = false;

  public EntityField(String name) {
    this.name = name;
    this.type = String.class;

    String columnName = StrUtil.format("{}_", StrUtil.toUnderlineCase(name));
    this.column = new TableColumnInfo(columnName);
  }

  public EntityField describe(String describe) {
    this.describe = describe;
    return this;
  }

  public EntityField type(Class<?> type) {
    this.type = type;
    return this;
  }

  public EntityField column(TableColumnInfo column) {
    this.column = column;
    return this;
  }

  public EntityField order(int order) {
    this.order = order;
    return this;
  }

  public EntityField isNotPersistence() {
    this.persistence = false;
    return this;
  }

  public EntityField lob() {
    this.lob = true;
    return this;
  }

  public EntityField idStrategyClass(Class<? extends IdStrategyValue> clazz) {
    this.idStrategyClass = clazz;
    return this;
  }

  public String getDescribe() {
    return StrUtil.isBlank(describe) ? this.column.getComment() : describe;
  }
}
